GridPACK: ymatrix_components.hpp Source File

00001 /*
00002  *     Copyright (c) 2013 Battelle Memorial Institute
00003  *     Licensed under modified BSD License. A copy of this license can be found
00004  *     in the LICENSE file in the top level directory of this distribution.
00005  */
00006 // -------------------------------------------------------------
00007 /**
00008  * @file   ymatrix_components.hpp
00009  * @author Bruce Palmer
00010  * @date   2016-07-14 13:27:00 d3g096
00011  * 
00012  * @brief  
00013  * 
00014  * 
00015  */
00016 // -------------------------------------------------------------
00017 
00018 #define USE_ACOPF
00019 
00020 #ifndef _ymatrix_components_h_
00021 #define _ymatrix_components_h_
00022 
00023 #include "boost/smart_ptr/shared_ptr.hpp"
00024 #include "gridpack/utilities/complex.hpp"
00025 #include "gridpack/component/base_component.hpp"
00026 #include "gridpack/component/data_collection.hpp"
00027 
00028 namespace gridpack {
00029 namespace ymatrix {
00030 
00031 enum YMatrixMode{YBus};
00032 
00033 class YMBus
00034   : public gridpack::component::BaseBusComponent {
00035   public:
00036     /**
00037      *  Simple constructor
00038      */
00039     YMBus(void);
00040 
00041     /**
00042      *  Simple destructor
00043      */
00044     ~YMBus(void);
00045 
00046     /**
00047      * Return size of matrix block on the diagonal contributed by
00048      * component
00049      * @param isize, jsize: number of rows and columns of matrix block
00050      * @return: false if network component does not contribute matrix
00051      *        element
00052      */
00053     bool matrixDiagSize(int *isize, int *jsize) const;
00054 
00055     /**
00056      * Return the values of for a diagonal matrix block. The values are
00057      * returned in row-major order
00058      * @param values: pointer to matrix block values
00059      * @return: false if network component does not contribute
00060      *        matrix element
00061      */
00062     bool matrixDiagValues(ComplexType *values);
00063 
00064     /**
00065      * Set values of YBus matrix. These can then be used in subsequent
00066      * calculations
00067      */
00068     void setYBus(void);
00069 
00070     /**
00071      * Modify diagonal values of matrix.
00072      * @param rval real part of diagonal matrix element
00073      * @param ival imaginary part of diagonal matrix element
00074      */
00075     void setYBusDiag(double rval, double ival);
00076 
00077     /**
00078      * Get values of YBus matrix. These can then be used in subsequent
00079      * calculations
00080      */
00081     gridpack::ComplexType getYBus(void);
00082 
00083     /**
00084      * Load values stored in DataCollection object into YMBus object. The
00085      * DataCollection object will have been filled when the network was created
00086      * from an external configuration file
00087      * @param data: DataCollection object contain parameters relevant to this
00088      *       bus that were read in when network was initialized
00089      */
00090     void load(const boost::shared_ptr<gridpack::component::DataCollection> &data);
00091 
00092     /**
00093      * Set the mode to control what matrices and vectors are built when using
00094      * the mapper
00095      * @param mode: enumerated constant for different modes
00096      */
00097     void setMode(int mode);
00098 
00099     /**
00100      * Return whether or not a bus is isolated
00101      * @return true if bus is isolated
00102      */
00103     bool isIsolated(void) const;
00104 
00105     /**
00106      * Change isolated status of bus
00107      * @param flag true if bus is isolated
00108      */
00109     void setIsolated(const bool flag);
00110 
00111     /**
00112      * Get shunt values
00113      * @param gl shunt GL value
00114      * @param bl shunt BL value
00115      */
00116     void getShuntValues(double *bl, double *gl) const;
00117 
00118     /**
00119      * Set internal parameters inside the Y-bus component
00120      * @param name character string describing component to be modified
00121      * @param value of parameter to be modified
00122      * @param idx index (if necessary) of variable to be modified
00123      */
00124     void setParam(std::string name, double value, int idx);
00125 
00126   private:
00127     double p_shunt_gs;
00128     double p_shunt_bs;
00129     bool p_shunt;
00130     int p_mode;
00131     bool p_isolated;
00132 
00133     // p_v and p_a are initialized to p_voltage and p_angle respectively,
00134     // but may be subject to change during the NR iterations
00135     double p_ybusr, p_ybusi;
00136 
00137 private:
00138 
00139 
00140   friend class boost::serialization::access;
00141 
00142   template<class Archive>
00143   void serialize(Archive & ar, const unsigned int version)
00144   {
00145     ar & boost::serialization::base_object<gridpack::component::BaseBusComponent>(*this)
00146       & p_shunt_gs
00147       & p_shunt_bs
00148       & p_shunt
00149       & p_mode
00150       & p_isolated
00151       & p_ybusr & p_ybusi;
00152   }  
00153 
00154 };
00155 
00156 class YMBranch
00157   : public gridpack::component::BaseBranchComponent {
00158   public:
00159     /**
00160      *  Simple constructor
00161      */
00162     YMBranch(void);
00163 
00164     /**
00165      *  Simple destructor
00166      */
00167     ~YMBranch(void);
00168 
00169     /**
00170      * Return size of off-diagonal matrix block contributed by the component
00171      * for the forward/reverse directions
00172      * @param isize, jsize: number of rows and columns of matrix block
00173      * @return: false if network component does not contribute matrix element
00174      */
00175     bool matrixForwardSize(int *isize, int *jsize) const;
00176     bool matrixReverseSize(int *isize, int *jsize) const;
00177 
00178     /**
00179      * Return the values of the forward/reverse matrix block. The values are
00180      * returned in row-major order
00181      * @param values: pointer to matrix block values
00182      * @return: false if network component does not contribute matrix element
00183      */
00184     bool matrixForwardValues(ComplexType *values);
00185     bool matrixReverseValues(ComplexType *values);
00186 
00187     /**
00188      * Set values of YBus matrix. These can then be used in subsequent
00189      * calculations
00190      */
00191     void setYBus(void);
00192 
00193     /**
00194      * Get values of YBus matrix. These can then be used in subsequent
00195      * calculations
00196      */
00197     gridpack::ComplexType getForwardYBus(void);
00198     gridpack::ComplexType getReverseYBus(void);
00199 
00200     /**
00201      * Load values stored in DataCollection object into YMBranch object. The
00202      * DataCollection object will have been filled when the network was created
00203      * from an external configuration file
00204      * @param data: DataCollection object contain parameters relevant to this
00205      *       branch that were read in when network was initialized
00206      */
00207     void load(const boost::shared_ptr<gridpack::component::DataCollection> &data);
00208 
00209     /**
00210      * Return the complex admittance of the branch
00211      * @return: complex addmittance of branch
00212      */
00213     gridpack::ComplexType getAdmittance(void);
00214 
00215     /**
00216      * Return transformer contribution from the branch to the calling
00217      * bus
00218      * @param bus: pointer to the bus making the call
00219      * @return: contribution from transformers to Y matrix
00220      */
00221     gridpack::ComplexType getTransformer(YMBus *bus);
00222 
00223     /**
00224      * Return the contribution to a bus from shunts
00225      * @param bus: pointer to the bus making the call
00226      * @return: contribution to Y matrix from shunts associated with branches
00227      */
00228     gridpack::ComplexType getShunt(YMBus *bus);
00229 
00230     /**
00231      * Return contributions to Y-matrix from a specific transmission element
00232      * @param tag character string for transmission element
00233      * @param Yii contribution from "from" bus
00234      * @param Yij contribution from line element
00235      */
00236     void getLineElements(const std::string tag,
00237         gridpack::ComplexType *Yii, gridpack::ComplexType *Yij);
00238 
00239     /**
00240      * Return contributions to Y-matrix from a specific transmission element at to end
00241      * @param tag character string for transmission element
00242      * @param Yii contribution from "from" bus
00243      * @param Yij contribution from line element
00244      */
00245     void getRvrsLineElements(const std::string tag,
00246         gridpack::ComplexType *Yii, gridpack::ComplexType *Yij);
00247 
00248     /**
00249      * Return status of all transmission elements
00250      * @return vector containing status of transmission elements
00251      */
00252     std::vector<bool> getLineStatus();
00253 
00254     /**
00255      * Return tags of all transmission elements
00256      * @return vector containging tag of transmission elements
00257      */
00258     std::vector<std::string> getLineTags();
00259 
00260     /**
00261      * Set the status of a transmission element based on its tag name
00262      * @param tag name of transmission element
00263      * @param status that transmission element should be set to
00264      * @return false if no transmission element with that name exists
00265      */
00266     bool setLineStatus(std::string tag, bool status);
00267 
00268     /**
00269      * Set the mode to control what matrices and vectors are built when using
00270      * the mapper
00271      * @param mode: enumerated constant for different modes
00272      */
00273     void setMode(int mode);
00274 
00275     /**
00276      * Get branch susceptance (charging)
00277      * @param tag string identifier for transmission element
00278      * @return value of susceptance
00279      */
00280     double getSusceptance(std::string tag);
00281 
00282     /**
00283      * Set internal parameters inside the Y-branch component
00284      * @param name character string describing component to be modified
00285      * @param value of parameter to be modified
00286      * @param idx index (if necessary) of variable to be modified
00287      */
00288     void setParam(std::string name, double value, int idx);
00289 
00290 #ifdef USE_ACOPF
00291     /**
00292      * Return components from individual transmission elements
00293      * @param yffr list of real parts of Yff
00294      * @param yffr list of imaginary parts of Yff
00295      * @param yttr list of real parts of Ytt
00296      * @param yttr list of imaginary parts of Ytt
00297      * @param yftr list of real parts of Yft
00298      * @param yftr list of imaginary parts of Yft
00299      * @param ytfr list of real parts of Ytf
00300      * @param ytfr list of imaginary parts of Ytf
00301      * @param switched flag on whether line is switched or not
00302      */
00303     void getYElements(std::vector<double> &yffr, std::vector<double> &yffi,
00304                       std::vector<double> &yttr, std::vector<double> &ytti,
00305                       std::vector<double> &yftr, std::vector<double> &yfti,
00306                       std::vector<double> &ytfr, std::vector<double> &ytfi,
00307                       std::vector<bool> &switched);
00308 #endif
00309 
00310   private:
00311     std::vector<double> p_reactance;
00312     std::vector<double> p_resistance;
00313     std::vector<double> p_tap_ratio;
00314     std::vector<double> p_phase_shift;
00315     std::vector<double> p_charging;
00316     std::vector<double> p_shunt_admt_g1;
00317     std::vector<double> p_shunt_admt_b1;
00318     std::vector<double> p_shunt_admt_g2;
00319     std::vector<double> p_shunt_admt_b2;
00320     std::vector<bool> p_xform, p_shunt;
00321     int p_mode;
00322     double p_ybusr_frwd, p_ybusi_frwd;
00323     double p_ybusr_rvrs, p_ybusi_rvrs;
00324     std::vector<bool> p_branch_status;
00325     std::vector<bool> p_switched;
00326     std::vector<std::string> p_tag;
00327     int p_elems;
00328     bool p_isolated;
00329     bool p_active;
00330 #ifdef USE_ACOPF
00331     std::vector<double> p_yffr, p_yffi;
00332     std::vector<double> p_yttr, p_ytti;
00333     std::vector<double> p_yftr, p_yfti;
00334     std::vector<double> p_ytfr, p_ytfi;
00335 #endif
00336 
00337 private:
00338 
00339 
00340   friend class boost::serialization::access;
00341 
00342   template<class Archive>
00343   void serialize(Archive & ar, const unsigned int version)
00344   {
00345     ar & boost::serialization::base_object<gridpack::component::BaseBranchComponent>(*this)
00346 #ifdef USE_ACOPF
00347       & p_yffr & p_yffi
00348       & p_yttr & p_ytti
00349       & p_yftr & p_yfti
00350       & p_ytfr & p_ytfi
00351 #endif
00352       & p_reactance
00353       & p_resistance
00354       & p_tap_ratio
00355       & p_phase_shift
00356       & p_charging
00357       & p_shunt_admt_g1
00358       & p_shunt_admt_b1
00359       & p_shunt_admt_g2
00360       & p_shunt_admt_b2
00361       & p_xform & p_shunt
00362       & p_mode
00363       & p_ybusr_frwd & p_ybusi_frwd
00364       & p_ybusr_rvrs & p_ybusi_rvrs
00365       & p_branch_status
00366       & p_switched
00367       & p_tag
00368       & p_elems
00369       & p_isolated
00370       & p_active;
00371   }  
00372 
00373 };
00374 
00375 
00376 }     // ymatrix
00377 }     // gridpack
00378 
00379 BOOST_CLASS_EXPORT_KEY(gridpack::ymatrix::YMBus)
00380 BOOST_CLASS_EXPORT_KEY(gridpack::ymatrix::YMBranch)
00381 
00382 
00383 #endif